home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / hackdisp.zip / HACKDISP.DOC < prev    next >
Text File  |  1992-12-24  |  10KB  |  248 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6. ================================================================================
  7.  
  8.           HACKDISP v1.2  copyright 1992 by James L. Powers
  9.  
  10.               A utility for converting
  11.  
  12.       ANSI and Laughing Dog v1.0 files to WC 3.x @COLOR@ codes
  13.  
  14.                      and
  15.  
  16.          WC! 3.x or ANSI display files to Laughing Dog v1.0
  17.  
  18.                  Brought to you by:
  19.  
  20.          The Dead LEEEEEEECH! Society BBS & Mortuary
  21.                    (614) 899-7839
  22.                  2400-9600 baud 8N1
  23.  
  24.  
  25. ================================================================================
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.    This  program  was  written after laboriously hand-converting an ANSI file
  33.    that should have been a piece of cake for a well known free utility widely
  34.    available for WC! 3.x sysops.
  35.  
  36.    HACKDISP is lazy.  It works by letting DOS  handle  the  ANSI  conversion.
  37.    Your  file is printed to the display and HACKDISP lifts the characters and
  38.    color attributes directly out of screen memory.  ANSI.SYS or an equivalent
  39.    ANSI driver must be loaded.  There is *NO* support for ANSI  animation  or
  40.    WC!  v2.x or 1.x system codes.
  41.  
  42.    HACKDISP  will  also convert from or to Laughing Dog v1.0 (copyright 1992,
  43.    Jeff Sloan) format if the file extension .DOG  is  found  in  the  command
  44.    line.   HACKDISP  determines  if the file is compressed or uncompressed by
  45.    examining the file length of a *.DOG file.  Files exactly  4010  bytes  in
  46.    length  are  considered  to  be  uncompressed.   Files under 4010 bytes in
  47.    length are assumed to be compressed.  If the  file  is  larger  than  4010
  48.    bytes, HACKDISP will yell at you and terminate.
  49.  
  50.    Support for LDOG files was originally intended for my own use, since I had
  51.    played  around  with  LDOGRAB.EXE,  Laughing Dog's excellent terminate and
  52.    stay resident (TSR) screen capture utility.  Since LDOGRAB's output format
  53.    is a ten byte header and a simple memory dump, I saw no reason for keeping
  54.    LDOGRAB in memory if all I was doing was converting files that had already
  55.    been created.
  56.  
  57.    Conversion of compressed files created by future versions of Laughing  Dog
  58.    is not guaranteed.
  59.  
  60.    In  addition to converting files, HACKDISP will also allow you to view the
  61.    converted files in color or black and white.
  62.  
  63.    A great deal of effort has been  put  into  making  HACKDISP  produce  the
  64.    smallest  possible  WC!   v3.x  equivalent  of  your  ANSI or Laughing Dog
  65.    files.  Although this will probably not help you save hard drive space, it
  66.    will help enhance Wildcat's  performance  when  displaying  @COLOR@  coded
  67.    screens,  since HACKDISP's mission is to create a display file with as few
  68.    attribute changes as possible.
  69.  
  70.    The output of HACKDISP can be used by WilDraw, but the preferred method is
  71.    the post-processing of TheDraw, ANSPAINT, or Laughing Dog files.
  72.  
  73.    It is assumed WC!  3.x sysops will know where and when to use  the  system
  74.    codes  necessary to pause or clear the display and will edit the output of
  75.    HACKDISP as required.
  76.  
  77.    HACKDISP will only handle one screen (25, 43, or 50 lines) at a time.  You
  78.    can specify the number of lines (1-50 depending on the current video mode)
  79.    to convert on the command line or  convert  the  entire  screen.   If  you
  80.    convert  a screen while in 43 or 50 line mode but view it in 25 line mode,
  81.    HACKDISP will scroll the display.  HACKDISP will refuse to run on monitors
  82.    with only 40 columns.
  83.  
  84.    HACKDISP will neither convert nor display files larger than 65,535  bytes.
  85.    That's the breaks.  Got one?  I'd like to see it!
  86.  
  87.    HACKDISP writes directly to screen memory during conversion, display,  and
  88.    scrolling and may cause "snow" on some CGA systems.
  89.  
  90.    HACKDISP will refuse to run on DOS versions less than 3.0, but I seriously
  91.    doubt  that  this  will  ever  be a problem for anyone.
  92.  
  93.    HACKDISP has been tested under DESQview and LANtastic and works well under
  94.    either  environment.   However,  SHARE  checking  and  file  locking   and
  95.    unlocking has not yet been implemented.  Look for it in version 1.3!
  96.  
  97.    HACKDISP is free for personal and non-business use.
  98.  
  99.  
  100. ================================================================================
  101. ================================================================================
  102.  
  103.  
  104.    Usage:
  105.  
  106.    To convert ANSI files to WC! 3.x @COLOR@ codes:
  107.  
  108.    HACKDISP [d:\path\] INPUT_FILE.EXT [d:\path\] OUTPUT_FILE.EXT [nn]
  109.  
  110.    To convert Laughing Dog v1.0 files to WC! 3.x @COLOR@ codes:
  111.  
  112.    HACKDISP [d:\path\] INPUT_FILE.DOG [d:\path\] OUTPUT_FILE.EXT [nn]
  113.                   ^^^
  114.    To convert ANSI or WC! 3.x files to Laughing Dog v1.0 format:
  115.  
  116.    HACKDISP [d:\path\] INPUT_FILE.EXT [d:\path\] OUTPUT_FILE.DOG
  117.                                  ^^^
  118.    To convert nn lines of the present screen to WC! 3.x @COLOR@ codes:
  119.  
  120.    HACKDISP SCREEN [d:\path\] OUTPUTFILE.EXT [nn]
  121.  
  122.    The value of nn is in the range 1-50  and  will  default  to  the  maximum
  123.    number  of  screen  lines  if  omitted.   nn  is  disregarded  if  you are
  124.    converting to Laughing Dog format.
  125.  
  126.    To view converted files in COLOR:
  127.  
  128.    HACKDISP [d:\path\] FILENAME.EXT /C
  129.  
  130.    To view converted files in B&W:
  131.  
  132.    HACKDISP [d:\path\] FILENAME.EXT /M
  133.  
  134.  
  135. ================================================================================
  136. ================================================================================
  137.  
  138.  
  139.    If you experience any difficulty converting any ANSI or LDOG file, viewing
  140.    any converted file, or if you are  experiencing  strange  results  when  a
  141.    converted  file  is  displayed  by Wildcat, please feel free to upload the
  142.    original ANSI or LDOG file and the file created by HACKDISP to the  "Sysop
  143.    ONLY"  file  section  of  The Dead LEEEEEEEECH!  Society BBS & Mortuary at
  144.    (614)899-7839 and the  problem  will  be  investigated.   Please  leave  a
  145.    message indicating which Wildcat version you are using!
  146.  
  147.    Remember  that  if your ANSI or LDOG screen uses all 80 columns, the local
  148.    Wildcat display may insert blank lines.  Remote viewing  will  look  fine.
  149.    It's best to use a maximum of 79 columns if you want things to look pretty
  150.    on  both  ends.  Also, HACKDISP will display characters that Wildcat, some
  151.    modems, and many communications programs may  not  like.   However,  since
  152.    most  ANSI  drawing  programs  don't  offer  90%  of  these characters, it
  153.    shouldn't be a problem.
  154.  
  155.    Beware of ASCII 127!  It is the "tiny house" or "delta" character  ()  in
  156.    the   IBM   graphics  character  set,  but  it  is  hardwired  in  several
  157.    telecommunications  packages  as  a  backspace.   Too  bad.   Nice  little
  158.    character.  At least all MSI products will display it.
  159.  
  160.    Displaying a single "@" character is still a hassle.  HACKDISP will always
  161.    display  one  correctly,  but  Wildcat  gets horribly confused whenever it
  162.    encounters one.  Avoid them like the plague and complain about it to  MSI.
  163.    It's not my problem.
  164.  
  165.    Please  note  that TOMCAT does an absolutely HORRID job converting @COLOR@
  166.    coded  files  back  to  ANSI.   Don't  be  surprised  if  your  HACKDISP'd
  167.    HELLOx.BBS  screens  get  truncated  when  they finally make it into a QWK
  168.    packet.  The folks at MSI should take a serious look  at  that  subroutine
  169.    and  FIX  IT  so  we  can  all  get on with the business of converting our
  170.    screens to this new format.  'Nuff said.
  171.  
  172.  
  173.  
  174.  
  175. ================================================================================
  176. ================================================================================
  177.  
  178.    NEW in v1.2:
  179.  
  180.     Added 43 line EGA and 50 line VGA support.  Removed  40  column  support,
  181.     which wasn't there in the first place!
  182.  
  183.     Added Laughing Dog v1.0 file conversion and display support.
  184.  
  185.     Added monochrome video support.  Never had any  complaints,  but  it  was
  186.     always  assumed  that HACKDISP would be running on a color system.  Since
  187.     HACKDISP reads and WRITES to screen memory at segments  B800-BFFF  during
  188.     the  conversion and display processes, some users with monochrome systems
  189.     and TSRs loaded high in that area may  have  experienced  system  crashes
  190.     with v1.1 and 1.0, or at least really WEIRD looking output.
  191.  
  192.     Stubborn  background  color  at  end  of  line  cured!  Wildcat evidently
  193.     expands a line that ends before the 80th column with spaces and the  last
  194.     background  attribute  it encountered.  HACKDISP's conversion and display
  195.     routines were modified to reflect this "feature" of Wildcat.  Many thanks
  196.     to Bryan Henderson, sysop of Ironhead  BBS  (614-794-2646)  for  bringing
  197.     this to my attention!
  198.  
  199.     Rewrote  @COLOR@  display  routine  to  access HACKDISP'd files in binary
  200.     mode.  A real can of worms.
  201.  
  202.     HACKDISP will  no  longer  show  @CLS@,  @STOP@,  @PAUSE@,  @NOSTOP@,  or
  203.     @NOPAUSE@  in  display  mode  and will now honk at you when it encounters
  204.     @BELL@.  All other system and user codes (as well  as  invalid  codes  of
  205.     your own invention surrounded by "@" characters) will be displayed.
  206.  
  207.     Rewrote ANSI display routine so that it no longer depends on the internal
  208.     DOS command buffer.
  209.  
  210.     Added input or output rejection based on file extension.
  211.  
  212.     Added  screen swapping, scrolling, and line clipping.  Since HACKDISP now
  213.     saves and restores your screen, a two second pause after  conversion  was
  214.     added.
  215.  
  216.     Added color & the famous DLS candelabra to default screen.
  217.  
  218.     Rewrote HACKDISP.DOC!
  219.  
  220.     Compiled under Borland C++ v3.1
  221.  
  222. ================================================================================
  223.  
  224.    NEW in v1.1:
  225.  
  226.     Default @00@ screen attribute changed to @0F@ to ensure compatibility
  227.     with WilDraw v1.0 and others.
  228.  
  229.     Extended internal DOS command buffer to allow for long path names.
  230.  
  231.     Support for the lone "@" character was removed.  According to MSI, this
  232.     will be fixed in future versions of Wildcat.
  233.  
  234.     Screen rows now end at last non-space character or last space with
  235.     non-default attribute.
  236.  
  237.     Fixed attribute bug that follows blank lines.
  238.  
  239.     Program now creates tighter files.
  240.  
  241.     Command line switch supports viewing converted files in color or
  242.     monochrome.
  243.  
  244.     Source code no longer distributed with the executable file.
  245.  
  246.  
  247.  
  248.